Indices operations

Copy or move an index

Copies or moves (renames) an index within the same Algolia application.

Existing destination indices are overwritten, except for their analytics data.
If the destination index doesn’t exist yet, it’ll be created.
This operation is resource-intensive.

Copy

Copying a source index that doesn’t exist creates a new index with 0 records and default settings.
The API keys of the source index are merged with the existing keys in the destination index.
You can’t copy the enableReRanking, mode, and replicas settings.
You can’t copy to a destination index that already has replicas.
Be aware of the size limits.
Related guide: Copy indices

Move

Moving a source index that doesn’t exist is ignored without returning an error.
When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name.
If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices.
Related guide: Move indices.

This operation is subject to indexing rate limits.

POST

indexes

{indexName}

operation

// Initialize the client
var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));

// Call the API
var response = await client.OperationIndexAsync(
  "<SOURCE_INDEX_NAME>",
  new OperationIndexParams
  {
    Operation = Enum.Parse<OperationType>("Move"),
    Destination = "<DESTINATION_INDEX_NAME>",
    Scope = new List<ScopeType>
    {
      Enum.Parse<ScopeType>("Rules"),
      Enum.Parse<ScopeType>("Settings"),
    },
  }
);
// >LOG

{
  "taskID": 1514562690001,
  "updatedAt": "2023-07-04T12:49:15Z"
}

Authorizations

x-algolia-application-id

string

header

required

Your Algolia application ID.

x-algolia-api-key

string

header

required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

indexName

string

required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

Body

application/json

Response

200

application/json

Response, taskID, and update timestamp.

Check task status List indices

// Initialize the client
var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));

// Call the API
var response = await client.OperationIndexAsync(
  "<SOURCE_INDEX_NAME>",
  new OperationIndexParams
  {
    Operation = Enum.Parse<OperationType>("Move"),
    Destination = "<DESTINATION_INDEX_NAME>",
    Scope = new List<ScopeType>
    {
      Enum.Parse<ScopeType>("Rules"),
      Enum.Parse<ScopeType>("Settings"),
    },
  }
);
// >LOG

{
  "taskID": 1514562690001,
  "updatedAt": "2023-07-04T12:49:15Z"
}

API reference

Authorizations

Path Parameters

Body

Response